home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 4 / CU Amiga Magazine's Super CD-ROM 04 (1996)(EMAP Images)(GB)(Track 1 of 3)[!][issue 1996-11].iso / magazine / psion / misc / tides2.lzx / readme02.txt
Text File  |  1995-10-05  |  12KB  |  336 lines
  1.          Tidal Prediction Program for the Psion Series 3a
  2.          ------------------------------------------------
  3.                    VERSION 2 - 5 October 1995
  4.                    --------------------------
  5.  
  6.                            USER GUIDE
  7.                            ----------
  8.  
  9.  
  10. First of all, my sincere thanks to all of you who have written to me with
  11. suggestions for improvements to Version 1. I WILL respond to each of you
  12. individually, soon.
  13.  
  14. This new release is still far from perfect, but I hope you will agree
  15. that it is much better than version 1.
  16.  
  17. I will continue to develop the programme as time permits and once again
  18. I welcome any suggestions you may have.
  19.  
  20. I haven't given the subject of Shareware and Registration much thought yet
  21. but I suppose my target price will be in the region of 10 to 15 pounds
  22. sterling.
  23.  
  24.  
  25. Purpose:
  26. --------
  27.  
  28. TidesV02 is intended for anyone who is interested in predicting the
  29. heights of the tide. It employs the Admiralty's Simplified Harmonic
  30. Method for tide prediction.
  31.  
  32. It will never produce results which are the same as the published Tide
  33. Tables and MUST NEVER be considered as a substitute for them. However, it
  34. comes very close !
  35.  
  36. Version 1.02, will only work until 31 December 1995.
  37.  
  38.  
  39.  
  40. Features:
  41. ---------
  42.  
  43. 1. Simple graphical output of the tide prediction for a 24-hour period.
  44. 2. Screen listing of heights at half-hourly intervals.
  45. 3. Listing to Text File of heights at half-hourly intervals.
  46. 4. Screen listing of the Harmonic Constants employed.
  47. 5. Editing facility to add, change and delete Harmonic Constants records
  48.    from the database.
  49. 6. Backup and Restore commands for the database.
  50. 7. Menu and hotkey commands.
  51. 8. Eighty Five (85) places and ports in the database.
  52. 9. Initialisation dialogue on first load to setup paths for files.
  53.  
  54.  
  55. Known Defficiences:
  56. -------------------
  57.  
  58. 1. There is no online Help
  59. 2. Parts of the input validation routines are too slow and should be 
  60.    improved.
  61. 3. The sort routine is not the most efficient available, but it is short !
  62. 4. No direct print routine of the graphics display.
  63.  
  64.  
  65. Planned Enhancements:
  66. ---------------------
  67.  
  68. 1. Optional on-line Help.
  69. 2. Astronomical data screen showing sun, moon, major planets and stars.
  70. 3. Links to Agenda and World.
  71. 4. Waypoint database for route planning etc.
  72. 5. Graphical output to printer.
  73. 6. More compact file structures.
  74. 7. Background, batch routine to pre-process output ready for use.
  75.  
  76.  
  77. Installation:
  78. -------------
  79.  
  80. The zip file TIDESV02.ZIP comprises the following files :
  81.  
  82.     README02.TXT ..........This text file
  83.     TIDESV02.OPA ..........The OPA application file
  84.     TIDESV02.HCS ..........The Database of ports Harmonic Constants
  85.     
  86. Hopefully, you will read this document before doing anything else !!!!
  87.  
  88. The files may be placed anywhere on your system. My suggestion is that
  89. you place the TIDESV02.OPA file in an \APP\ directory and create a
  90. new directory called \TIDESV02 to contain the database file TIDESV02.HCS.
  91.  
  92. Once you have installed the OPA, and run it, the program executes a short
  93. initialisation sequence requesting the path name of the directory in 
  94. which you stored the HCS file.
  95.  
  96. If it finds it there, it then creates TIDESV02.INI in the same directory
  97. as the one that contains the OPA file and then never bothers you again.
  98.  
  99. The default path-name is stored in the INI file which is read every time
  100. the application loads. If you want to change the default path, just
  101. delete the INI file and go through the dialogue again.
  102.  
  103. In  my setup, I only have the standard 512k of ram with no other SSDs. 
  104. It looks like this :
  105.  
  106.                          Disk Internal
  107.  
  108.                    \APP\
  109.                          TIDESV02.INI
  110.                          TIDESV02.OPA
  111.  
  112.                    \TIDESV02\
  113.                          DEFAULT .TXT
  114.                          TIDESV02.BAK
  115.                          TIDESV02.DBF
  116.                          TIDESV02.AFS
  117.                          TIDESV02.HCS
  118.                          TIDESV02.HTS
  119.  
  120.  
  121. The other files are all created as necessary by the program.
  122.  
  123. The key files are the AFS and HTS files which contain the results of many
  124. of the calculations to avoid having to re-calculate every time for the
  125. same port and date. As the records become 'out-of-date' the program
  126. deletes them in order to keep the size of the files down. This might cause
  127. problems if you chose Flash SSD to contain your default path.
  128.  
  129. The BAK file is created when you edit the HCS file. It may be restored if
  130. you aren't happy with the results.
  131.  
  132. DEFAULT.TXT  is the default name of the file to which the half-hourly
  133. heights are listed. I expect you will choose a meaningful name such as
  134. 'DOVER.TXT' etc...
  135.  
  136. The DBF file is a mere skeleton of the file used to link with the DATA
  137. application. It is cleared down as valid records are imported into the
  138. HCS database file. Only invalid records will remain in this file for
  139. re-editing.
  140.  
  141.  
  142. Operation:
  143. ----------
  144.  
  145. I have populated the HCS database file with the Harmonic Constants for 
  146. 85 locations :
  147.  
  148. Barrow (Ramsden Dock)        Nab Tower
  149. Bergen (Norway)            Narvik (Norway)
  150. Brightlingsea             Newquay
  151. Bristol (Avonmouth)         Northney
  152. Brodick Bay            Oban
  153. Bucklers Hard            Padstow
  154. Campbeltown            Plymouth (Devonport)
  155. Cherbourg (France)        Poole (Entrance)
  156. Chichester Harbour (Entrance)    Poole (Town Quay)
  157. Cowes (Isle of Wight)        Port of Kem' (Russia)
  158. Craighouse            Portland
  159. Cuxhaven (Germany)        Portsmouth
  160. Dartmouth            Ramsgate
  161. Deal                River Tees Entrance
  162. Dover                Rosyth
  163. Dunbar                Ryde (Isle of Wight)
  164. Esbjerg (Denmark)        Selsey Bill
  165. Exmouth (Approaches)        Sheerness
  166. Exmouth Dock            Shoreham
  167. Falmouth            Solva
  168. Felixstowe Pier            Southampton
  169. Fidra                St. Ives
  170. Fishguard            St. Mary's (Isles of Scilly)
  171. Foreland (Lifeboat Slip, IOW)    St. Vaast-la-Hougue (France)
  172. Glasgow                Stansore Point
  173. Greenock            Stonehaven
  174. Hamburg (Germany)        Stornoway
  175. Harwich                Swanage
  176. Holyhead            Tarbert Island (Ireland)
  177. Inverness            Teignmouth (Approaches)
  178. Ipswich                Teignmouth (Shaldon Bridge)
  179. Itchenor            Tilbury
  180. Knights Town (Ireland)        Tobermory
  181. Kyle of Lochalsh        Torquay
  182. Le Havre (France)        Troon
  183. Leith                Ullapool
  184. Lisbon (Portugal)        Ventnor (Isle of Wight)
  185. Llandudno            Walton-on-the-Naze
  186. London Bridge            West Mersea
  187. Lymington            Wick
  188. Margate                Wilhelmshaven (Germany)
  189. Menai Bridge            Yarmouth (Isle of Wight)
  190. Milford Haven        
  191.  
  192. The initial dialog invites you to choose one of these ports along with the
  193. date and time you would like to predict the tides. 
  194.  
  195. Then it calculates various factors due to the longitude of the sun and 
  196. moon and some constant data for the chosen location to produce a 24 hour
  197. tidal prediction curve.
  198.  
  199. Once a curve is displayed, you may adjust the time in several ways by 
  200. pressing 'hot keys' :
  201.  
  202.     + (PLUS) ...........Advances the time by 5 minutes
  203.     - (MINUS) ..........Retards the time by 5 minutes
  204.     UP Arrow ...........Advances the time by 1 hour
  205.     DOWN Arrow .........Retards the time by 1 hour
  206.     RIGHT Arrow ........Advances the time by 15 minutes
  207.     LEFT Arrow .........Retards the time by 15 minutes
  208.     PSION UP Arrow .....Advances the time by 6 hours
  209.     PSION DOWN Arrow ...Retards the time by 6 hours
  210.     PSION UP Arrow .....Advances the time by 3 hours
  211.     PSION DOWN Arrow ...Retards the time by 3 hours
  212.  
  213. Other Hot keys are :
  214.  
  215.     ENTER ..............Invites you to input the date & time
  216.     t or PSION t .......Invites you to input the time only
  217.     s or PSION s .......Invites you to select a new place, date & time
  218.  
  219.     c or PSION c .......Displays the current Harmonic Constants
  220.     h or PSION h .......Displays half-hourly heights
  221.     f or PSION f .......Prompts for a file name for listing heights
  222.  
  223.     PSION n ............Launches the DATA application so you can 
  224.                 create new port/place records
  225.  
  226.     PSION e ............Copies the current port/place to a DBF file
  227.                 and launches the DATA application so you can
  228.                 edit and/or create new port/place records
  229.  
  230.     PSION w ............Allows you to delete (wipe) a record from
  231.                 the HCS file
  232.  
  233.     PSION SHIFT E ......Copies ALL of the port/place records to a DBF
  234.                 file so you can edit, list etc to your hearts
  235.                 content.
  236.                 BEWARE : This is a very lengthy process since
  237.                 the program has to validate every record. Be
  238.                 patient it will finish. It then sorts the
  239.                 records.
  240.                 If you are not happy with your chages then
  241.                 you are able to 'Discard' them before finally
  242.                 writing them back to the file.
  243.  
  244.     PSION b ............Creates a backup of the main HCS file
  245.  
  246.     PSION r ............Restores the main HCS file from the backup
  247.  
  248.     PSION x ............Exits the program - but not before tidying up
  249.                 redundant records from the AFS and HTS files.
  250.  
  251.     MENU ...............Presents a menu with most of the above.
  252.  
  253.  
  254. During several processes, the program displays a busy signal while it
  255. calculates literally hundreds of formulae.
  256.  
  257. During critical file IO activities, program locks are applied temporarily
  258. to prevent corrupting the files.
  259.  
  260. The program is littered with dialogs to confirm actions so you can't do 
  261. anything seriously wrong without getting a chance to think again.
  262. If you do get tied up in knots, you can simply reinstall and start again.
  263.  
  264.  
  265. Editing Rules:
  266. --------------
  267.  
  268. The program outputs the Harmonic Constants for you to edit into a DATA 
  269. file named TIDESV02.DBF.
  270.  
  271. Then it launches the DATA application and waits for it to exit.
  272.  
  273. On exit it processes all of the file and validates the records. If it
  274. detects an error it will write 'ERROR' into the field and update the 
  275. record. Valid records are allowed to update the main HCS database and are
  276. then deleted from the DBF file. Any invalid records are left behind in the
  277. DBF file and the DATA application is relaunched for you to inspect and
  278. re-edit them. Look for fields with contents 'ERROR'. 
  279.  
  280. Error records are also marked in the ID field with the word 'ERROR', this
  281. must also be re-edited, but note that it doesn't overwrite the originl
  282. content of the ID field, just appends to it.
  283.  
  284. In order to edit or create new records you must have access to one of the
  285. Admiralty Tide Tables (publcation nos :NP201, NP202, NP203 or NP160).
  286.  
  287. The fields needed can be found in Parts 1,2,3 and in Table VI.
  288.  
  289. The format required is as follows :
  290.  
  291. Place:     up to 32 characters, no validation
  292. ID:     the id from the first column of ATT Part 3, max 5 characters
  293. Lat'd:     The Latitude of the place format can use a decimal point in place
  294.     of the degree symbol, upper or lower case NnSs eg 55.23n Take from
  295.            ATT Part 1 or Part 2
  296. Long:     as for Lat'd except must be EeWw eg 2.34e
  297. Zone:     allows 0,GMT,UTGMT or in format of -0100, take from ATT Part 3
  298. ML Z0:     directly from ATT Part 3, third column. If no data is given ie.
  299.            the field contains 'w' then input an asteriski *. This indicates
  300.            that the ML fluctuates markedly according to  the proximity of
  301.            springs. See fields ML(Sp) and ML(+7) below.
  302.  
  303. M2 g:     These and the following fields down to F 6: are taken directly
  304. M2 H:     from ATT Part 3. As above, if no data is in this column input an
  305. S2 g:     asterisk *.
  306. S2 H: , K1 g: , K1 H: , O1 g: , O1 H: , f 4: , F 4: , f 6: , F 6:
  307.  
  308. SC (12):Take directly from ATT Part 3 . If the data given is 'negligible'
  309. M2 (12):or not given then as before, iput a single asterisk *.
  310. S2 (12):The 12 values should be separated by a comma
  311.  
  312. Lag(x): This is the number of days lag behind new or full moon that
  313.         springs occur. It is taken either from ATT Part 1 or from the 
  314.         supplementary tables Table VI in the second column (x).
  315.  
  316. ML(Sp): This and the following field is given when no data is provided in
  317. ML(+-7):the MLZ0 field. The values we're interested in are in Table VI 
  318.         columns labelled 'At Springs' for ML(Sp) and labelled '1' to '7'
  319.         for ML(+-7). The ML(+-7) fields should be separated by commas. 
  320.  
  321.  
  322. Have a good look through th TIDESV02.DBF file once you have exported ALL
  323. the constants and you will soon get the hang of it.
  324.  
  325.  
  326.  
  327.  
  328. Finally, as ever, I welcome comments and suggestions to improve this 
  329. program.
  330.  
  331. Have fun.
  332.  
  333. Stephen Muchow
  334. Compuserve Mail 100432,3316
  335.  
  336.